Try to document the horror of the command line options we provide for Tiger.
authorrobertl <robertl>
Thu, 8 Jun 2006 02:50:39 +0000 (02:50 +0000)
committerrobertl <robertl>
Thu, 8 Jun 2006 02:50:39 +0000 (02:50 +0000)
xmldoc/formats/options/tiger-genurl.xml
xmldoc/formats/options/tiger-iconismarker.xml
xmldoc/formats/options/tiger-margin.xml
xmldoc/formats/options/tiger-newmarker.xml
xmldoc/formats/options/tiger-nolabels.xml
xmldoc/formats/options/tiger-oldmarker.xml
xmldoc/formats/options/tiger-oldthresh.xml
xmldoc/formats/options/tiger-snlen.xml
xmldoc/formats/options/tiger-suppresswhite.xml
xmldoc/formats/options/tiger-xpixels.xml
xmldoc/formats/options/tiger-ypixels.xml

index 8b137891791fe96927ad78e64b0aad7bded08bdc..d1bd24f2b6fc8015f4a04aa3b0ac467d1c6acfae 100644 (file)
@@ -1 +1,18 @@
+<para>
+genurl is a convenience option for generating the scaling paramaters
+when accessing the Tiger servers.  It will output the latitude, longitude,
+height, and width parameters in a form suitable for use in the URL to generate
+a map that will hold all the points to be displayed  and is suitably scaled
+and centered.   
+</para>
+<para>For example:
+<screen format="linespecific">gpsbabel -i geo -f geocaching.loc -o tiger,genurl=tiger.ctr -F tiger.dat</screen>
+may create tiger.ctr with
+<screen format="linespecific">lat=36.042108&amp;lon=-86.877408&amp;ht=0.161172&amp;wid=0.591771&amp;iwd=768&amp;iht=768</screen>
+
+After uploading tiger.dat to a public server, a request to 
+<screen format="linespecific"> http://tiger.census.gov/cgi-bin/mapgen?murl=$THATFILE$(cat tiger.ctr)</screen>
+will return a gif file from the tiger server that's suitably scaled.
+
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..899aed557b675b321150a58bad9fee261f728113 100644 (file)
@@ -1 +1,4 @@
-
+<para> This options signifies that the icon in the incoming format is to be used
+without change in the generated Tiger output file.  Without this option,
+GPSBabel tries to color pins based on their creation time and certain 
+Geocaching traits when available.</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..e9b58184a1a988f237ad246eedeaa9fb07d42a72 100644 (file)
@@ -1 +1,7 @@
-
+<para>This option specifies a margin around the maps for the genurl options.
+The margin may be specified in either decimal degrees or as a 
+percentage.</para>
+<para>
+This option is most useful for ensuring there is adaequate space for
+the label around the markers when generating automatically scaled maps.
+</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..ec3af7c123f816176133022469f752f6781646d4 100644 (file)
@@ -1 +1,3 @@
-
+<para>This option specifies the pin to be used if a waypoint has a creation
+time older than 'oldthresh' days.</para>
+<para>The default is "greenpin".</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..33ec2c1cb155c22a4bf302b4a75e4f827099bd68 100644 (file)
@@ -1 +1,3 @@
-
+<para>This option tells GPSBabel to not generate labels on the pins.   If
+this is true, the description of the incoming waypoints are ignored and not
+placed on the pins.</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..abce81d927d0905d983039a1e4e741806d8a9e36 100644 (file)
@@ -1 +1,3 @@
-
+<para>This option specifies the pin to be used if a waypoint has a creation
+time newer than 'oldthresh' days.</para>
+<para>The default is "redpin".</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..919026372837dd701013f757a7c3560659bb9b50 100644 (file)
@@ -1 +1,5 @@
-
+<para>This options allows you to control the threshold in days between
+whether a pin is considered "new" (and thus potentially governed by the
+'newmarker' option) or "old" (and thus potentially governed by the 
+'oldmarker' option).
+</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..ae39cd7367ea2d290a0b7730c637984ad7640f06 100644 (file)
@@ -1 +1,5 @@
-
+<para>
+The snlen option controls the maximum length of names generated by the '-s'
+option.  It's particularly useful in Tiger maps to avoid the amount of clutter
+generated by potentially lengthy labels on the markers.
+</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..6576ef45c301a7f8f9fc74fa0150e085e7c70cf9 100644 (file)
@@ -1 +1,4 @@
-
+<para>
+When set, this options tells the '-s' smartname generator to not allow 
+any spaces in the labels generated for markers.
+</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..a857af3ed9782a4eb92c7a819f999f963426d269 100644 (file)
@@ -1 +1,3 @@
-
+<para>The xpixels argument lets you specify the number of pixels to be
+generated by the Tiger server along the horizontal axis when using the 
+'genurl' option.  </para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..846de24a437c325d51c307b9735ae9705d5eb36a 100644 (file)
@@ -1 +1,4 @@
+<para>The ypixels argument lets you specify the number of pixels to be
+generated by the Tiger server along the vertical axis when using the
+'genurl' option.  </para>